Document the CARGO_HOME env var
authorHugo Duncan <hugo@hugoduncan.org>
Wed, 8 Apr 2015 18:32:29 +0000 (14:32 -0400)
committerHugo Duncan <hugo@hugoduncan.org>
Wed, 8 Apr 2015 18:32:29 +0000 (14:32 -0400)
Adds CARGO_HOME to the config documentation.

src/doc/config.md

index a6aaab69e99a8ebbc6242ec5b70a5dbcc634ce07..9cfab21bafaad9be053d6f7b963caaef7d48e984 100644 (file)
@@ -78,3 +78,10 @@ timeout = 60000   # Timeout for each HTTP request, in milliseconds
 [build]
 jobs = 1        # number of jobs to run by default (default to # cpus)
 ```
+
+# Configuration of registry cache
+
+Cargo maintains a local cache of the registry index and of git
+checkouts of crates.  By default these are stored under
+`$HOME/.cargo`. The location can be overridden by setting the
+`CARGO_HOME` environment variable.